Node / meshtastic / Meshtastic-Android / files / .specify / templates / spec-template.md

Displaying Rendered • View raw • Download

Feature Branch: T383838[###-feature-name]

Created: [DATE]

Status: Draft

Input: User description: "$ARGUMENTS"

Cross-Platform Spec: <!-- Link to meshtastic/design/features/ spec, or "N/A — platform-specific only" with justification -->

<!--

Provide a brief (2-3 sentence) summary of the feature, its purpose, and what

user problem it solves. Mention which modules are primarily affected.

CROSS-PLATFORM CHECK: Before writing this spec, check meshtastic/design/features/

for an existing cross-platform behavior spec. If one exists, this spec should describe

the Android-specific scope and acceptance criteria — not redefine the cross-platform

behavior. If none exists and this feature affects multiple platforms, create one first

using the TEMPLATE.md in that repo.

-->

<!--

List 3-5 goals this feature achieves. Be specific and measurable.

-->

<!--

Explicitly state what this feature does NOT do to prevent scope creep.

-->

<!--

IMPORTANT: User stories should be PRIORITIZED as user journeys ordered by importance.

Each user story/journey must be INDEPENDENTLY TESTABLE - meaning if you implement just ONE of them,

you should still have a viable MVP (Minimum Viable Product) that delivers value.

Assign priorities (P1, P2, P3, etc.) to each story, where P1 is the most critical.

Think of each story as a standalone slice of functionality that can be:

• Developed independently

• Tested independently

• Deployed independently

• Demonstrated to users independently

-->

[Describe this user journey in plain language]

Why this priority: [Explain the value and why it has this priority level]

Independent Test: [Describe how this can be tested independently - e.g., "Can be fully tested by [specific action] and delivers [specific value]"]

Acceptance Scenarios:

1. Given [initial state], When [action], Then [expected outcome]

2. Given [initial state], When [action], Then [expected outcome]

[Describe this user journey in plain language]

Why this priority: [Explain the value and why it has this priority level]

Independent Test: [Describe how this can be tested independently]

Acceptance Scenarios:

1. Given [initial state], When [action], Then [expected outcome]

[Describe this user journey in plain language]

Why this priority: [Explain the value and why it has this priority level]

Independent Test: [Describe how this can be tested independently]

Acceptance Scenarios:

1. Given [initial state], When [action], Then [expected outcome]

[Add more user stories as needed, each with an assigned priority]

<!--

ACTION REQUIRED: The content in this section represents placeholders.

Fill them out with the right edge cases.

-->

• What happens when [boundary condition]?

• How does system handle [error scenario]?

<!--

ACTION REQUIRED: The content in this section represents placeholders.

Fill them out with the right functional requirements.

-->

• FR-001: System MUST [specific capability]

• FR-002: System MUST [specific capability]

• NFR-001: [Performance, accessibility, or quality requirement]

<!--

ACTION REQUIRED: Describe the layout structure, data flow, and key components.

Include ASCII diagrams for visual layouts and Mermaid flowcharts for data flow.

Reference existing composables from core:ui where applicable.

-->

<!--

List the components involved in this feature with their module paths and purpose.

Reference existing components from core:ui, core:model, etc. where applicable.

-->

<!--

ACTION REQUIRED: Identify which KMP source sets this feature affects.

All business logic and UI MUST be in commonMain (Constitution I, III).

-->

<!--

ACTION REQUIRED: Note any UI elements that must be reviewed against the

Meshtastic Client Design Standards (Constitution V). Flag intentional

deviations with rationale.

-->

• [ ] New screens reviewed against design standards

• [ ] M3 component selection verified (e.g., T383838SwitchPreference not raw T383838Switch)

• [ ] Accessibility: TalkBack semantics, touch targets, color-independent info

• [ ] Typography: T383838titleMediumEmphasized for emphasis, M3 scale for hierarchy

<!--

ACTION REQUIRED: Confirm this feature does not violate Constitution IV.

If the feature handles any sensitive data, document the safeguards.

-->

• [ ] No PII, location data, or cryptographic keys logged or exposed

• [ ] No new network calls that transmit user data

• [ ] Generated proto not hand-edited (the T383838org.meshtastic:protobufs Maven dependency)

<!--

ACTION REQUIRED: Define measurable success criteria.

These must be technology-agnostic and measurable.

-->

• SC-001: [Measurable metric]

• SC-002: [Measurable metric]

<!--

ACTION REQUIRED: The content in this section represents placeholders.

Fill them out with the right assumptions based on reasonable defaults

chosen when the feature description did not specify certain details.

-->

• All business logic and UI composables reside in T383838commonMain source set

• String resources added to T383838core/resources/src/commonMain/composeResources/values/strings.xml

• Icons use T383838MeshtasticIcons (from T383838core/ui/icon/)

• Float values pre-formatted with T383838NumberFormatter.format() (CMP constraint)

• [Additional feature-specific assumptions]